Skip to content

Switch to a custom version dropdown#617

Merged
xylar merged 4 commits into
MPAS-Dev:masterfrom
xylar:switch-to-version-dropdown
Apr 10, 2025
Merged

Switch to a custom version dropdown#617
xylar merged 4 commits into
MPAS-Dev:masterfrom
xylar:switch-to-version-dropdown

Conversation

@xylar
Copy link
Copy Markdown
Collaborator

@xylar xylar commented Apr 10, 2025

sphinx-multiversion was not working correctly in that it:

  • did not use the appropriate dependencies for each version of pyremap
  • did not reinstall pyremap when it checked out a new version of pyremap, causing issues with the auto-generated API

This merge removes sphinx-multiversion and instead adopts a custom version dropdown developed with help form ChatGPT.

For now at least, the version dropdown will only be available in main and future releases of MPAS-tools (though we could back-port the dropdown and rebuild older versions of the docs if desired).

This pull request includes several changes focused on improving the documentation build process and enhancing the versioning system for the mpas_tools package. The most important changes include replacing sphinx-multiversion with a custom versioning solution, updating the documentation build commands, and adding a version switcher to the documentation.

Documentation Build Process Improvements:

Version Switcher Implementation:

Documentation Content Updates:

Miscellaneous Changes:

@xylar xylar self-assigned this Apr 10, 2025
@xylar xylar merged commit d9b3f96 into MPAS-Dev:master Apr 10, 2025
6 checks passed
@xylar xylar deleted the switch-to-version-dropdown branch April 10, 2025 04:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant